Skip to main content

XREAL

The XREAL package targets Nebula-compatible devices (XREAL Air, Air 2, Air 2 Pro) and bundles controller profiles plus color-space optimizations. Only Enterprise accounts get access to the distribution.

Enterprise Access

  • Share your XREAL device SKU, planned regions, and distribution method (Nebula for Windows vs. Android).
  • WebAR³ will grant access to:
    • com.webarvps.vps.xreal (Unity package).
    • Native companion APKs for Nebula integration and USB host detection.
    • Sample UX for heads-up overlays that respect the limited field of view.

Enterprise only: XREAL-specific rendering pipelines and Nebula bridge services are not part of the public SDK.

Prerequisites

  • XREAL Air series glasses with the latest firmware and Nebula Companion 3.0+.
  • Host device (Android 12+ or Windows 11) capable of running Unity builds.
  • Unity 2022.3 LTS with URP and Android/Windows build support installed.

Setup Steps

  1. Install the Enterprise package and import the XREAL_HUD.unity sample scene.
  2. Switch build target:
    • Android deployments: Use IL2CPP, target API 33, and enable the Nebula Bridge checkbox in Player Settings.
    • Windows deployments: Enable PC, Mac & Linux Standalone with Windows target and check Use Primary Display Only to prevent duplicate rendering.
  3. Open Project Settings → XR Plug-in Management and enable OpenXR, then add the WebAR³ XREAL Feature Group.
  4. On VPSLocalisationService, assign the provided XRealPoseAdapter component to smooth head pose data.
  5. Deploy to the host device, launch Nebula, and confirm the Unity view streams to the glasses.

Testing Checklist

  • Verify localization stability while walking slowly; the XREAL IMU introduces drift above 1.5 m/s.
  • Test brightness-controlled overlays so UI remains readable in bright environments.
  • Confirm the fallback 2D UI renders on the host phone/tablet when glasses disconnect.
  • Run through the Enterprise Diagnostics scene to collect pose, frame rate, and localization logs for support.

Support

Enterprise customers can request tailored UX audits for gesture-only interaction, plus firmware validation ahead of large deployments.